home *** CD-ROM | disk | FTP | other *** search
/ The Original Shareware 1.1 / The Original Shareware (WeMake CDs)(Volume 1.1)(CDs, Inc)(1993).iso / 18 / quickq.zip / QQ.DOC < prev    next >
Text File  |  1990-03-14  |  14KB  |  346 lines
  1.  
  2.                               QuickQ Documentation
  3.                          V. 1.00 M. Frankel March 1990
  4.                          -----------------------------
  5.  
  6. This archive contains the following files and statistics. If the numbers
  7. you receive from running the enclosed batch file CHECK.BAT do not match
  8. those listed below, please DELETE ALL FILES which came from the archive
  9. QUICKQ.ZIP and contact the author at CHICAGO VOICE BBS (See below for
  10. telephone number).
  11.  
  12.                  QUICKQ.ZIP - Size 31,789
  13.                               Date 3-14-90
  14.  
  15.                      QQ.EXE - Size 20,973
  16.                               Date 3-14-90
  17.                               Check Method 1 - C2D1
  18.                               Check Method 2 - 01B4
  19.  
  20.                VALIDATE.COM - Size 6,485
  21.                               Date 10-31-89
  22.                               Check Method 1 - CB21
  23.                               Check Method 2 - 13B7
  24.  
  25.                VALIDATE.DOC - Size 1,653
  26.                               Date 10-28-90
  27.                               
  28.                      QQ.DOC - Size 13,972
  29.                               Date 3-14-90
  30.  
  31.                     READ.ME - Size 1,871
  32.                               Date 3-14-90
  33.  
  34.                   CHECK.BAT - Size 994
  35.                               Date 3-14-90
  36.  
  37.                      CV.ZIP - Size 7,562
  38.                               Date 1-28-90
  39.                               Check Method 1 - 5B2C
  40.                               Check Method 2 - 183F
  41.  
  42.                   QQMAC.ZIP - Size 1,596
  43.                               Date 03-14-90
  44.                               Check Method 1 - 76D1
  45.                               Check Method 2 - 012D
  46. What is QuickQ ?
  47. ----------------
  48. QuickQ (QQ) was initially designed to be used with Applied Systems
  49. Technologies, Inc.'s QEDIT editor. QQ itself is shareware, and is
  50. designed to be used with the registered or "shareware" versions of QEDIT
  51. 'The quick editor' from SemWare.
  52.  
  53. QuickQ was developed to for two reasons:
  54.  
  55.    1. Save and restore the screen when calling QEDIT. The shareware
  56.       versions since 2.0 have not restored the screen after exiting
  57.       qedit and returning to PC or MS DOS.
  58.  
  59.    2. When QQ is involked without a file or list of files, it will load
  60.       the files which were last edited. I find this feature sorely
  61.       lacking in Qedit since it would be so easy to implement. This
  62.       feature is widely used with other editors like BRIEF.
  63.  
  64. Intended audience for QuickQ
  65. ----------------------------
  66. Programmers who do not use integrated environments, who like Qedit, and
  67. are involved in long term projects. I use C and assembler at work and
  68. found Brief too slow (it isn't really an editor, it's a macro processer
  69. engine). But I really like brief's ability to re-load multiple files and
  70. the cursor positions without having to re-enter the paths/names. I dis-like
  71. having to resort to franticly searching for a dos command in a dos-like editor.
  72.  
  73. QuickQ Usage
  74. ------------
  75.  
  76. QQ [?] [file1] [file2] [file3] ...
  77.  
  78. Where:
  79.          ? = will show the environment variables used and examples.
  80.  
  81. Environment variables used:
  82.  
  83.        QQ   - holds the path AND filename of the QEDIT program (or the
  84.               name of a batch file which calls qedit. I use norton
  85.               guides so my Q.BAT file looks like ( I copy it to my ram
  86.               drive and place the ram drive in my path):
  87.  
  88.                      ng qedit.exe %1 %2 %3 %4 %5 %6 %7 > nul
  89.  
  90.               Examples:
  91.  
  92.                   SET QQ=D:\QEDIT.EXE (to call the qedit directly)
  93.                   SET QQ=D:\Q.BAT     (to call the qeditor from a batch
  94.                                         file which calls qedit).
  95.  
  96.  
  97.        QTMP - holds the path AND filename of the temporary file to
  98.               create to store the file name(s) which will be passed to
  99.               qedit. Like the QQ variable, i reccommend using a ram
  100.               drive for this:
  101.  
  102.               Example:
  103.  
  104.                       SET QTMP=D:\$QQ$
  105.                       SET QTMP=C:\TEMP\anything.tmp
  106.  
  107. Explanation of Files
  108. --------------------
  109. QQ.EXE - QuickQ. The shell program from which qedit will be called.
  110.          QuickQ saves the screen and filename(s) passed to a temporary
  111.          file prior to calling qedit with the parameters. When QQ.EXE is
  112.          entered on the DOS prompt without parameters, it will attempt
  113.          to open the temporary file (if it exists! ) and re-call qedit
  114.          with the filenames you last entered.
  115.  
  116.          I first wrote this program with the intention to call QEDIT
  117.          with the same files since last edit. Un-like "other" editors,
  118.          QQ can not re-position the cursor at the last edited position
  119.          in the file(s). Maybe I'll do that later, or someone else could
  120.          try it. Please upload the modified source to the Chicago Voice
  121.          BBS listed below.
  122.  
  123.          I first used the macro facility of QEDIT (INIT.MAC) to do this, but
  124.          it was just geting very sloppy, and eventually wouldn't provide the
  125.          screen save feature. I included it for those with a flair for QEDIT
  126.          macro language.
  127.  
  128.          The source code is free and pulic domain. To obtain it call CHICAGO
  129.          VOICE BBS Oak Park, IL (708) 982-0126. 1200/300 8N1. It is contained
  130.          in the file QQSRC.ZIP. Note: Since Chicago Voice is a voice system,
  131.          you will have to wait 30 seconds for a 1200 carrier tone AFTER
  132.          the first voice prompt (about 40 seconds total).
  133.  
  134. QQ.DOC  - This file.
  135.  
  136. VALIDATE.COM - Validation Program provides File size, date, time and checksum
  137.                figures for anti-viral protection.
  138.  
  139. VALIDATE.DOC  - Documentation for VALIDATE.COM
  140.  
  141. READ.ME - Ad for Chicago Voice BBS.
  142.  
  143. CHECK.BAT - The bath file which when run will provide you with the means to
  144.             check the files in this archive for tampering or vandalism.
  145.  
  146. QQMAC.ZIP - Zip file containing INIT.MAC,INIT.TXT, INIT2.MAC, INIT2.TXT
  147.  
  148.           INIT.MAC,  INIT.TXT - INIT will save the name of the file to
  149.           INIT2.MAC,INIT2.TXT   at load time, INIT2 will load the file
  150.                                 saved by INIT.
  151.  
  152.                                 The binary and source file to load and execute
  153.                                 as an autostart macro. Both the init and init2
  154.                                 macros must be called from the command line
  155.                                 with the -e option of QEDIT 2.1. I would call
  156.                                 QEDIT from a batch file which i named Q.BAT,
  157.                                 after renaming Q.EXE to QEDIT.EXE.
  158.  
  159.                                 Heres how the batch file would look like when
  160.                                 I was using the macro files:
  161.  
  162.                                   @echo off
  163.                                   if exist C:\Q\$QTEMP$.LST goto l2
  164.                                   if "%1" == "" goto l1
  165.                                   qedit %1 %2 %3 -einit.mac
  166.                                   goto l3
  167.                                   :l1
  168.                                   qedit
  169.                                   goto l3
  170.                                   :l2
  171.                                   qedit -ed:\init2.mac nul
  172.                                   :l3
  173.  
  174. f10 MacroBegin Splitline MarkColumn Currentfilename MarkColumn  \
  175.     goto_block_beg EditFile 'c:\q\$Qtemp$.lst' return MoveBlock \
  176.     SaveFile quit delch file
  177.  
  178.     Whew ! See why I decided to write a program
  179.     to do this ?
  180.  
  181. Helpful Hints:
  182.  
  183.  You can use qq right out of "the box", so long as you:
  184.  
  185.                 1. Rename your Q.EXE to QEDIT.EXE
  186.                                 or
  187.                            set QQ=Q.EXE
  188.                 2. You have a hard drive as C:  (if not, set QTMP=X
  189.                    where X is a drive you know which will always exist.
  190.  
  191.                 3. Be sure that the directory which the qeditor is located
  192.                    in in your PATH.
  193.  
  194.  
  195. Here's how i use QuickQ with qedit:
  196.  
  197.       Step 1. I re-name QQ.EXE (QuickQ) to Q.EXE
  198.       Step 2. Rename Q.EXE (Qedit) to QEDIT.EXE. Let's assume the
  199.               directory where qedit is located is in your path.
  200.       Step 3. Create a batch file called Q.BAT which is located in the
  201.               C:\Q directory and looks like this (Note: the '@' will
  202.               supress the echo off command, but only will work with
  203.               DOS 3.3 or greater):
  204.  
  205.               @echo off
  206.               ng qedit %1 %2 %3 %4 %5 %6 %7 %8 %9 %10 %11 %12 >nul
  207.  
  208.               (I use norton guides to invoke Qeditor, you can do
  209.                whatever you want in the batch file.)
  210.  
  211.       Step 4. Add the following lines to your autoexec.bat file. set
  212.               QTMP to D:\$Q$        (if D: is your ram drive designator)
  213.  
  214.               set QQ = C:\Q\Q.BAT
  215.  
  216.       Step 5. Re-boot.
  217.  
  218.  
  219. Error/Warning Messages from QuickQ
  220. ----------------------------------
  221. ( Note: All error/warning messages will be written to STDERR )
  222.  
  223. QQ Oops: Error in Load Module. Please delete QuickQ.
  224.  
  225. -This is a self-check of QuickQ. Re-extract the QQ.EXE from the
  226.  archive. (Exit code 1)
  227.  
  228. QQ Oops : Cannot execute parameter lines longer than 128 characters.
  229.    The command line:
  230.    <command_line>
  231.    is <integer> characters long.
  232.  
  233. -This is informing you that your command line is greater than 128
  234.  characters long. (Exit code 2)
  235.  
  236. QQ Oops: Error opening file drive:<path>/<filename>
  237.  
  238. -This error message is diplayed when quickq can't open either the
  239.  temporary path/filename which you specified in the QTMP variable, or
  240.  can't open the default temporary file, which is 'C:\$QQ$.TMP'.
  241.  (Exit code 3)
  242.  
  243. QQ Oops : Error writing file <QuickQ_temporary_file_spec>
  244.  
  245. -This is telling you that QuickQ could not open the temporary file
  246.  for writing. It will be most likely to happen if you specified a
  247.  drive which doesn't exist, or you don't have a C: drive.
  248.  (Exit code 4)
  249.            
  250. QQ Oops : Error closing file <QuickQ_temporary_file_spec>
  251.  
  252. -This is telling you that QuickQ could not close the temporary file.
  253.  It will be most likely to happen if you run out of drive space or
  254.  flag the temporary file 'hidden' or 'read-only'.
  255.  (Exit code 5)
  256.  
  257. QQ Oops : Error reading from file <QuickQ_temporary_file_spec>
  258.  
  259. -This is telling you that QuickQ could not write to the temporary
  260.  file. It will be most likely to happen if you run out of
  261.  drive space or flag the temporary file 'read-only'.
  262.  ( Exit code 6 )
  263.  
  264. QQ Oops : Error closing file <QuickQ_temporary_file_spec>
  265.  
  266. -This is telling you that QuickQ could not close the temporary file.
  267.  It will be most likely to happen if you run out of drive space.
  268.  ( Exit code 7)
  269.                
  270. QQ Oops: Error running command line:
  271.  
  272. <command_line>
  273.  
  274. Try checking:
  275.    -COMSPEC to verify that programs can locate COMMAND.COM
  276.    -Your command line is not longer that 128 characters.
  277.        
  278. -This error message is diplayed when quickq can't run the command line
  279.  which calls qedit or can't locate the COMMAND.COM file. Also, if you
  280.  really can't enter a command longer than 128 characters into the DOS
  281.  command line, but you can from a batch file. (Exit code 8)
  282.  (Exit code 8)
  283.  
  284. QQ Message : File drive:<path>/<filename> does not exist. Give QQ a filename
  285.              next time.
  286.  
  287. -This isn't really an error message. QuickQ is informing you that it
  288.  can't find the temorary file, and that you haven't specified a file
  289.  name to edit. QuickQ will call QEDIT with a blank filename so you can
  290.  choose which file you want to edit.
  291.        
  292. Trouble-Shooting
  293. ----------------
  294. Q. I've done what you said, but when I enter Q nothing happens except
  295.    the following message is displayed:
  296.  
  297.     ░▒▓ QuickQ v1.0 March 1990 M. Frankel
  298.  
  299. A. Either Q.EXE cannot find the file QEDIT.EXE or your environment
  300.    variable QQ does not exist. Perform your usual trouble shooting steps
  301.    (ie; be sure the Qedit program is in a directory which is in your
  302.    path; you've not run out of environment space, etc.)
  303.  
  304.    If this fails:
  305.  
  306.       1. Be sure the QQ variable is set to a good filename. try typing
  307.           what you set QQ to in your autoexec.bat file and see if the
  308.           qeditor runs.
  309.  
  310.       2. If you will not be using the QQ variable, BE SURE THAT THE
  311.          QEDITOR IS RE-NAMED TO QEDIT.EXE !
  312.  
  313.       You should now type Q and get Qedit, along with saving your last
  314.       edited file and initial screen. If you don't call Chicago voice for
  315.       further assistance.
  316.  
  317. Q. I used to be able to edit files of 10,000 lines, but since I've been
  318.    using QuickQ, I'm only able to load files of around 9,000 lines.
  319.  
  320. A. There's a trade-off with using QuickQ (As with anything in life!). If
  321.    you are usually editing huge files, use another editor. If 99% of the
  322.    time you are editing program files of 5,000 lines or less, use QuickQ !
  323.  
  324. Q. How do I get the Source Code for QuickQ ?
  325. A. Call Chicago Voice BBS at (708) 982-0126. 1200/8/N/1. After
  326.    registration you will be able to d/l QQSRC.ZIP. This contains C source
  327.    code for QuickQ.
  328.  
  329. The Disclaimer
  330. --------------
  331. Use of this program acknowledges this disclaimer of warranty: "This
  332. program is supplied as is.  I disclaim all warranties, express or
  333. implied, including, without limitation, the warranties of
  334. merchantability and of fitness of this program for any purpose.  I
  335. assume no liability for damages direct or consequential, which may
  336. result from the use of this program."
  337.  
  338. QEDIT is is a registered trademark of Applied Systems Technologies,
  339.        Inc., dba Semware.
  340. MS-DOS is a registered trademark of Microsoft Corporation.
  341. PC-DOS is a registered trademark of IBM Corporation.
  342. BRIEF  is a registered trademark of UnderWare, Inc.
  343. VALIDATE is from McAfee Associates
  344.  
  345.  
  346.